<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>rdebug_watch_variables: common_schema documentation</title>
	<meta name="description" content="rdebug_watch_variables: common_schema" />
	<meta name="keywords" content="rdebug_watch_variables: common_schema" />
	<link rel="stylesheet" type="text/css" href="css/style.css" />
</head>

<body>
	<div id="main">
		<div id="header">
			<h1>common_schema</h1> <strong>2.2</strong> documentation
			<div class="subtitle">DBA's framework for MySQL</div>
		</div>
		<div id="contentwrapper">
			<div id="content">
				<h2><a href="rdebug_watch_variables.html">rdebug_watch_variables</a></h2>	
<h3>NAME</h3>
rdebug_watch_variables(): List user defined variables and local variables visible and used within current scope, with their current values.

<h3>TYPE</h3>
Procedure

<h3>DESCRIPTION</h3>
<p>
	This procedure is part of the <a href="rdebug_api.html">rdebug API</a>.
</p>
<p>
	<i>rdebug_watch_variables()</i> lists the names, locations and most importantly
	the <i>values</i> of local variables and user defined variables currently visible
	on the <i>worker</i>. 
</p>
<p>
	At any given time throughout the <i>worker's</i> execution, some variables are
	visible, some not (not in scope, such as variables belonging to a routine that
	called the currently executing routine). These would be routine parameters and
	local variables. Also, user defined variables can be used by a routine.
</p>
<p>
	Any local variable/parameter which is visible at the time of calling
	<i>rdebug_watch_variables()</i>, and any user defined variable used by the
	current executing <i>worker's</i> routine, are presented along with their values.
	This excludes variables injected by <strong>rdebug</strong> itself, as these
	only serve to the purpose of managing the debugging session.
</p>
<p>
	Execution of this routine only makes sense on an active debugging session, i.e.
	after calling <a href="rdebug_start.html">rdebug_start()</a>.
</p>

<h3>SYNOPSIS</h3>
<p>
<blockquote><pre>rdebug_watch_variables()
  READS SQL DATA
</pre></blockquote>
</p>
<p>
  Output: 
  <ul>
    <li><strong>routine_schema</strong>: schema of routine containing variable.</li>
    <li><strong>routine_name</strong>: name of routine containing variable.</li>
    <li><strong>variable_name</strong>: name of variable.</li>
    <li><strong>variable_type</strong>: type of variable. Either:
    	<ul>
    		<li><strong>param</strong>: routine parameter</li>
    		<li><strong>local</strong>: local routine variable</li>
    		<li><strong>user_defined</strong>: user defined (session) variable</li>
    	</ul>
    </li>
    <li><strong>variable_value</strong>: BLOB representation of current value.</li>
  </ul>
</p>

<h3>EXAMPLES</h3>
	<p>
		Watch variables on a routine with only local variables:
	<blockquote><pre>mysql&gt; call rdebug_watch_variables();
+----------------+--------------------+-------------------+---------------+----------------+
| routine_schema | routine_name       | variable_name     | variable_type | variable_value |
+----------------+--------------------+-------------------+---------------+----------------+
| test           | analyze_continents | current_continent | local         | Europe         |
| test           | analyze_continents | done              | local         | 0              |
+----------------+--------------------+-------------------+---------------+----------------+
</pre></blockquote>
</p>
	<p>
		Watch variables on a routine with a parameter and which uses a user defined variable:
	<blockquote><pre>mysql&gt; call rdebug_watch_variables();
+----------------+--------------------------+-------------------+---------------+----------------+
| routine_schema | routine_name             | variable_name     | variable_type | variable_value |
+----------------+--------------------------+-------------------+---------------+----------------+
| test           | analyze_continent_cities | @avg_count_cities | user_defined  | 18.282608695   |
| test           | analyze_continent_cities | @count_countries  | user_defined  | 46             |
| test           | analyze_continent_cities | current_continent | param         | Europe         |
+----------------+--------------------------+-------------------+---------------+----------------+
</pre></blockquote>
</p>

<h3>ENVIRONMENT</h3>
MySQL 5.1 or newer

<h3>SEE ALSO</h3>
<a href="rdebug_get_variable.html">rdebug_get_variable()</a>,
<a href="rdebug_set_variable.html">rdebug_set_variable()</a>,
<a href="rdebug_verbose.html">rdebug_verbose()</a>

<h3>AUTHOR</h3>
Shlomi Noach
				<br/>
			</div>
			<div id="sidebarwrapper">
				<div id="search">
					Search online documentation
					<form id="search_form" name="search_form" method="GET" 
						action="http://www.google.com/search" 
						onsubmit="document.forms['search_form']['q'].value = 'site:http://common-schema.googlecode.com/svn/trunk/common_schema/doc/html/ '+document.forms['search_form']['search_term'].value;">
						<input type="text" name="search_term" value=""/>
						<input type="hidden" name="q" value=""/>
						<input type="submit" value="go"/>						
					</form>
				</div>
				<div id="menu">
					<ul>
						<li><a title="Introduction" href="introduction.html">Introduction</a></li>
						<li><a title="Documentation" href="documentation.html">Documentation</a></li>
						<li><a title="Download" href="download.html">Download</a></li>
						<li><a title="Install" href="install.html">Install</a></li>
						<li><a title="Risks" href="risks.html">Risks</a></li>
					</ul>						
					<h3>QUERY SCRIPT</h3>
					<ul>
						<li><a title="QueryScript" href="query_script.html">QueryScript</a></li>
						<li><a title="Execution" href="query_script_execution.html">Execution</a></li>
						<li><a title="Flow control" href="query_script_flow_control.html">Flow control</a></li>
						<li><a title="Statements" href="query_script_statements.html">Statements</a></li>
						<li><a title="Expressions" href="query_script_expressions.html">Expressions</a></li>
						<li><a title="Variables" href="query_script_variables.html">Variables</a></li>
					</ul>						
					<h3>DEBUG</h3>
					<ul>
						<li><a title="rdebug" href="rdebug.html">rdebug</a></li>
						<li><a title="rdebug API" href="rdebug_api.html">rdebug API</a></li>
						<li><a title="rdebug workflow" href="rdebug_workflow.html">Workflow</a></li>
					</ul>						
					<h3>ROUTINES</h3>
					<ul>
						<li><a title="Execution &amp; flow control" href="execution_routines.html">Execution & flow control</a></li>
						<li><a title="General" href="general_routines.html">General</a></li>
						<li><a title="Process" href="process_routines.html">Process</a></li>
						<li><a title="Query analysis" href="query_analysis_routines.html">Query analysis</a></li>
						<li><a title="Schema analysis" href="schema_analysis_routines.html">Schema analysis</a></li>
						<li><a title="Security" href="security_routines.html">Security</a></li>
						<li><a title="Text" href="text_routines.html">Text</a></li>
						<li><a title="Time &amp; date" href="temporal_routines.html">Time & date</a></li>
						<li><a title="Charting" href="charting_routines.html">Charting</a></li>
					</ul>
					<h3>VIEWS</h3>
					<ul>
						<li><a title="Schema analysis" href="schema_analysis_views.html">Schema analysis</a></li>
						<li><a title="Data dimension" href="data_dimension_views.html">Data dimension</a></li>
						<li><a title="Process" href="process_views.html">Process</a></li>
						<li><a title="Security" href="security_views.html">Security</a></li>
						<li><a title="Monitoring" href="monitoring_views.html">Monitoring</a></li>
						<li><a title="InnoDB Plugin" href="innodb_plugin_views.html">InnoDB Plugin</a></li>
						<li><a title="Percona server" href="percona_server_views.html">Percona Server</a></li>
						<li><a title="TokuDB" href="tokudb_views.html">TokuDB</a></li>
					</ul>						
					<h3>DATA</h3>
					<ul>
						<li><a title="tables" href="tables.html">Tables</a></li>
						<li><a title="variables" href="variables.html">Variables</a></li>
					</ul>						
					<h3>META</h3>
					<ul>
						<li><a title="Help" href="help.html">help</a></li>
						<li><a title="Metadata" href="metadata.html">metadata</a></li>
						<li><a title="status" href="status.html">status</a></li>
					</ul>						
				</div>
			</div>	
			<div class="clear">&nbsp;</div>
			
			<div id="footnote" align="center">
				<a href="">common_schema</a> documentation
			</div>
		</div>
	</div>
</body>
</html>
